/*
 * MIT License
 *
 * Copyright (c) 2018 Alen Turkovic
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.alinesno.cloud.compoment.distributed.lock.api.key;

import java.lang.reflect.Method;
import java.util.List;

/**
 * Used to generate keys to lock.
 */
public interface KeyGenerator {
  /**
   * Generate keys by evaluating the given expression.
   *
   * @param lockKeyPrefix prefix to put on resolved keys
   * @param expression    key expression to evaluate
   * @param object        the root object of the expression (the object with the locked method)
   * @param method        the executed method
   * @param args          arguments with which the method was called
   * @return generated or resolved keys
   */
  List<String> resolveKeys(String lockKeyPrefix, String expression, Object object, Method method, Object[] args);
}
